home *** CD-ROM | disk | FTP | other *** search
/ Joystick Magazine 1996 September / cd joy 74 No16.iso / pc / data / cooli / agpg / agedit.txt next >
Text File  |  1996-06-25  |  10KB  |  196 lines
  1. AG Scenario Editor
  2. - initial release 6/25/96
  3. - Bill Haering
  4. - ewz6ar@meb.em.gmr.com
  5.  
  6.  
  7. 1.0 introduction
  8.  
  9. By combining the Panzer General Editor with some Qbasic translation programs an 
  10. Allied General Editor has been created.  The overall system requires that a few more steps 
  11. be executed than with just the Panzer General Editor, but it does provide a functioning 
  12. editor for AG scenarios (and I believe it is the first one).  In addition, it allows PG 
  13. scenario to be used by AG.  Conversely, AG scenarios could be used in PG, but some 
  14. additional steps would need to be taken (described below).
  15.  
  16. This package should include the following files
  17.  
  18. pzgmaped.exe   --- these three files    
  19. pzgmaped.txt        constitute the  
  20. pgplay.bat          original PG editor
  21.  
  22. agtopg1.bas  --- these five files are the
  23. pgtoag1.bas        additions that allow
  24. agtopg.bat         the PG editor to edit
  25. pgtoag.bat          AG scenarios
  26. readme.txt
  27.  
  28. *** Note *** This editor is still under development.  While it currently supports nearly 
  29. all of the functions that the original PG editor does, a few remaining bugs (listed below 
  30. section 4.0) are still being worked on.  My intention was to get a functioning editor out as 
  31. quickly as possible and update it as I go along.  While the program shouldn't overwrite 
  32. any Original AG or PG files, all standard disclaimers apply.  I sum them up as, use at you 
  33. own risk. Also the pgplay.bat file isn't necessary to use the AG editor, but is part of the 
  34. original PG editor and is included as the documentation that comes with that editor 
  35. requests that it be included.
  36.  
  37. The rest of this description covers the following:
  38.  
  39. 1.1 Overview of Use
  40. 2.0 Directory Set-Up
  41. 2.1 Additional Files Required for Use
  42. 2.2 Copies of Original Scenarios
  43. 3.0 Example of Editor Use
  44. 3.1 Campaign Use
  45. 4.0 Current Limitations
  46. 5.0 How AG Scenarios might be used in PG
  47. 6.0 Final Remarks
  48.  
  49.  
  50. 1.1 Overview of Use
  51.  
  52. In the following description of how to use this editor, it is useful to understand the 
  53. general operation of the AG scenario editor.  First, an AG scenario (one file) is broken 
  54. down into the PG format (three files).  The resulting PG scenario representation can then 
  55. be edited using the PG editor (see   pzgmaped.txt   for a description).  After saving the 
  56. edited PG representation, a separate program combines the three PG format files together 
  57. to make a AG scenario file that can be used by AG.
  58.  
  59.  
  60. 2.0 Directory Set-Up
  61.  
  62. The translation programs assume a directory structure as follows.
  63.  
  64. c:\agedit
  65. c:\agedit\ag
  66. c:\agedit\pg
  67.  
  68. All seven files that are include in this editor should be placed in the c:\agedit directory.
  69.  
  70.  
  71. 2.1 Additional Files Required for Use
  72.  
  73. The PG editor that is the heart of this AG editor requires two PG/AG files to operate.  
  74. These are the  panzequp.eqp   and   mapnames.str   files.  Both PG and AG contain copies 
  75. of these files, but they are different.  To the best of my knowledge that difference lies in 
  76. the number of entries of units (and some of the descriptive parameters) in the 
  77. panzequp.eqp file, and the number of entries in the mapnames.str file. The file that come 
  78. with AG are largesr than the PG ones, and are the one that are needed for this editor to 
  79. work. The PG editor will function with either set of those two files, but editing AG 
  80. scenarios you will get a non-fatal error if you use the PG files (because the scenarios use 
  81. city names or units not include in the PG version of the files).  For that reason, use the 
  82. AG version of the two files mentioned above.  I recommend placing those two files in the 
  83. C:\agedit\pg  directory.
  84.  
  85.  
  86. 2.2 Copies of Original Scenarios
  87.  
  88. Copies of the AG scenario files game0xx.scn (where xx goes from 01 to 39) must be 
  89. placed in the c:\agedit\ag  directory.  They are used as starting points for changes to the 
  90. scenario or to create completely different one, and they are also used to get headers that 
  91. must be included in the final AG files that aren't stored in the intermediate PG files.
  92.  
  93. *** Note***  When finally used the edited AG scenario files will overwrite the AG 
  94. scenario files (this step is a manual one).  As a result, a backup copy must be made.  The 
  95. scenario files should be on you hard disk under the Scenario sub-directory (of the 
  96. directory where Allied Genral is).  I suggest making a sub-sub-directory   scenario\bak   
  97. and storing copies of the 39 scenario files there.  Then after you have used the edited 
  98. scenarios, you can restore the originals by copying them back into the scenario sub-
  99. directory.  Make sure that you have a copy of your edited scenario elsewhere.
  100.  
  101. PG scenarios can be converted for use in AG.  If this is desired, place copies of the PG 
  102. scenario files (mapxx.stm,mapxx.set, and game0xx.scn, where xx goes between 01 and 
  103. 38) into the  c:\agedit\pg  directory.
  104.  
  105. *** Note *** both PG and AG uses the filename game0xx.scn (xx goes between 01 and 
  106. 39).  In AG this is the only file used to describe the scenario, while in PG it is one of 
  107. three.
  108.  
  109.  
  110. 3.0 Example of Editor Use
  111.  
  112. The following example covers editing an existing AG scenario.  This is composed of the 
  113. following steps
  114.  
  115. 1  Run agtopg.bat  
  116. 2  Answer questions
  117.    -  input AG file number 01 - 39 ?     (for Crusader  enter 03)
  118.    - input PG file number 39 - 99 ?    (enter any number, ex: 99)
  119.    - hit return to continue     (hit return)
  120. 3  Run pzgmaped.exe  and select file just save above  (c:\agedit\pg\map99.stm) in this 
  121. case.  When using the PG editor on AG scenarios, the AXIS and ALLIED labels will be 
  122. INTERCHANGED.
  123. 4  Save edited file  (could be any number from 39 to 99, in this case choose  70)
  124. 5  Run pgtoag.bat
  125. 6  Answer questions 
  126.     - input original AG file number 01 - 39 ?   (in this case 03, this is to get some header 
  127. information and in fact any file number would actually work)
  128.     - input PG file number where edited game was saved 39 - 99 ?  (70 in his case)
  129.     - input new AG file number 01 - 99 (doesn't overwrite original, it's in a different 
  130. directory) ?   (choose 03, which will mean it will be read in finally as crusader)
  131. 7  copy file created in step 6 (game003.scn in this example) to the Allied General 
  132. Scenario sub-directory.  THIS WILL OVERWRITE THE ORIGINAL SCENARIO FILE, 
  133. so you should have made a backup of it (see section 2.2).
  134. 8  Run Allied General and chose Scenario Crusader (which is internal scenario number 3)
  135. 9  When finished you should copy back-up copy of file back to Allied General Scenario 
  136. sub-directory (game003.scn, in this example). 
  137.  
  138.  
  139. You can read a PG scenario into AG by starting at step 6 and inputting the number of a 
  140. preexisting PG scenario (provided that you had previously copied the associated file to 
  141. c:\agedit\pg  , see section 2.2).  Note that the axis will be labeled at allies and vice-a-versa 
  142. (see section 4.0).
  143.  
  144.  
  145. 3.1 Campaign Use
  146.  
  147. By editing some or all of the scenarios in the AG scenario path, you can change the 
  148. individual scenarios in the campaign.  The scenarios are numbered consecutively from 
  149. right to left in the scenario page.  That in combination with the scenario path should 
  150. provide enough information.
  151.  
  152.  
  153. 4.0 Current Limitations
  154.  
  155. Some of the limitations of this editor are more or less permanent.  The reverse labeling of 
  156. axis and allied in the editor is unavoidable.  Also if PG scenario are read into AG this 
  157. reverse labeling will occur.  This doesn't affect anything other than the labeling.  Thus in 
  158. AG scenarios the British, Americans and Russians (and their allies), will be called axis 
  159. countries in the PG editor.  Their units will be represented by crosses, and the Germans 
  160. (and their allies) will be represented by stars.  On the other hand if PG scenarios are read 
  161. into AG the Germans will have the first turn, and will be labeled with stars.  The British, 
  162. Russians, or Norwegians will be represented as crosses (in the map view).
  163.  
  164. There are also some small bugs that I haven't completely worked out.  I don't advise 
  165. editing the entries in the scenario screen in the PG editor labeled (s+12, s+14, ...,s+25, 
  166. ...,u-8,...,u-2) as there appears to be an offset that I haven't completely figure out.  Take 
  167. the values that came with the original AG scenario and leave them alone. How this affects 
  168. the PG scenarios that are read into AG, I'm not completely sure, but I need to look at it.  I 
  169. have read in Warsaw and played it, and it played just fine.  Also I haven't been able to 
  170. read the first PG scenario, Poland, into AG.  For some reason it gives an error.  I'm 
  171. working on these issues and hope to put out an update.
  172.  
  173.  
  174. 5.0 How AG Scenarios might be used in PG
  175.  
  176. In theory there is no reason why AG scenario can't  be read into PG.  You would just use 
  177. steps 1 and 2 outlined in section 3.0.  Then follow the instructions for the use of edited 
  178. PG scenarios in the pzgmaped.txt file.  There are several things to consider.  First the 
  179. offset in the values mentioned above (section 4.0) would exist in the other direction.  
  180. Also the panzeqp.eqp and mapnames.str file for PG don't include all the entries in many 
  181. of the AG scenarios.  I suspect that the AG copies of these files could be used to eliminate 
  182. this problem.  Of course given the better AI of AG, I don't know why you would read AG 
  183. scenarios into PG.
  184.  
  185.  
  186. 6.0  Final Remarks
  187.  
  188. I hope that you find this editor useful.  I readily admit that it is a little cumbersome to use.  
  189. But then it is currently the only one that I'm aware of..  It includes the source code for the 
  190. translation programs in Qbasic (in fact there is no compiled version) and you should feel 
  191. free to use it as you please.  I invite your questions and comments, but consider the spirit 
  192. in which this editor is offered, and the price, free.
  193.  
  194. Bill Haering
  195. ewz6ar@meb.em.gmr.com
  196.